楽天Edy決済 API一覧
※idPass版にのみ対応しています。json版には対応しておりません。
HTTP仕様（.idPass）
| Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
|---|---|---|
| Method |
POST |
|
| Response header |
Content-Type: text/plain;charset=windows-31j |
|
| Status Code |
200：常に200を返却 |
|
EntryTranEdy 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
ExecTranEdy 決済実行
お客様が入力した情報で楽天Edyセンターと通信を行い決済を実施し、結果を返します。
リクエスト
| AccessID |
必須
半角英数32桁 固定
取引ID【取引登録】で発行された値を設定します。 |
|
|---|---|---|
| AccessPass |
必須
半角英数32桁 固定
取引パスワード【取引登録】で発行された値を設定します。 |
|
| OrderID |
必須
半角英数記号27桁
オーダーID【取引登録】で指定した値を設定します。 |
|
| MailAddress |
必須
半角英数記号256桁
メールアドレスお客様が楽天Edyに登録したメールアドレスを設定します。 |
|
| ShopMailAddress |
半角英数記号256桁
加盟店メールアドレス
お客様へ結果通知メールを送信する際に同時に加盟店様にも送信する場合のメールアドレスを設定してください。BCCで設定されます。
|
|
| EdyAddInfo1 |
全半角180桁
決済開始メール付加情報お客様へ決済依頼メールに付加する文章を指定します。 |
|
| EdyAddInfo2 |
全半角320桁
決済完了メール付加情報お客様へ決済完了メールに付加する文章を指定します。 |
|
| PaymentTermDay |
半角数字2桁
支払期限日数省略時は、ショップ情報に設定された支払期限日数で処理されます。 |
|
| PaymentTermSec |
半角数字5桁
支払期限秒
最大86,400秒(1日)
|
|
| ClientField1 |
全半角100バイト
加盟店自由項目1 |
|
| ClientField2 |
全半角100バイト
加盟店自由項目2 |
|
| ClientField3 |
全半角100バイト
加盟店自由項目3 |
|
| ClientFieldFlag |
半角数字1桁
加盟店自由項目返却フラグ
以下のいずれかを設定します。
|
|
/payment/ExecTranEdy.idPassAccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&MailAddress=test@example.comレスポンス
正常
| OrderID |
半角英数記号27桁
オーダーID【決済実行】呼び出し時に指定した値を返却します。 |
|
|---|---|---|
| ReceiptNo |
半角英数記号16桁
受付番号
Edy受付番号を返却します。
|
|
| EdyOrderNo |
半角英数記号40桁
Edy注文番号
オーダーID ＋ - ＋ 連番の値を返却します。
|
|
| PaymentTerm |
半角数字14桁 固定
支払期限日時
お客様の払込期限を返却します。
|
|
| TranDate |
半角数字14桁 固定
決済日付
決済依頼を実施した日時を返却します。
|
|
| CheckString |
半角英数32桁
MD5ハッシュ
OrderID～TranDate＋ショップパスワードのハッシュ値(※1)を返却します。
|
|
| ClientField1 |
全半角100バイト
加盟店自由項目1【決済実行】で加盟店自由項目返却フラグが1：返却するの場合のみ返却します。 |
|
| ClientField2 |
全半角100バイト
加盟店自由項目2【決済実行】で加盟店自由項目返却フラグが1：返却するの場合のみ返却します。 |
|
| ClientField3 |
全半角100バイト
加盟店自由項目3【決済実行】で加盟店自由項目返却フラグが1：返却するの場合のみ返却します。 |
|
OrderID=ORDER0000001&ReceiptNo=GDgm1J5k06090410&EdyOrderNo=ORDER0000001-220609334516&PaymentTerm=20220630235959&TranDate=20220630101059&CheckString=12abcd11c2b95555d3cb1433c11111e9&ClientField1=&ClientField2=&ClientField3=ErrCode=E01&ErrInfo=E01040001SearchTradeMulti 取引状態参照
指定したオーダーIDの取引情報を取得します。
レスポンス
正常
| Status |
現状態
UNPROCESSED：未決済
|
|
|---|---|---|
| ProcessDate |
半角数字14桁 固定
処理日時yyyyMMddHHmmss書式 |
|
| AccessID |
半角英数32桁 固定
取引ID |
|
| AccessPass |
半角英数32桁 固定
取引パスワード |
|
| Amount |
半角数字10桁
利用金額 |
|
| Tax |
半角数字10桁
税送料
|
|
| SiteID |
半角英数13桁
サイトID
|
|
| Currency |
半角英字3桁
通貨コード決済に利用された通貨を返却します。 |
|
| ClientField1 |
全半角100バイト
加盟店自由項目1
|
|
| ClientField2 |
全半角100バイト
加盟店自由項目2
|
|
| ClientField3 |
全半角100バイト
加盟店自由項目3
|
|
| PayType |
半角数字2桁
決済方法2：楽天Edy |
|
| EdyReceiptNo |
半角英数記号16桁
受付番号
Edy受付番号を返却します。
|
|
| EdyOrderNo |
半角英数記号40桁
Edy注文番号オーダーID ＋ - ＋ 連番 |
|
| PaymentTerm |
半角数字14桁 固定
支払期限日時yyyyMMddHHmmss書式 |
|
Status=PAYSUCCESS&ProcessDate=20220630101059&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&SiteID=tsite11223344&Currency=&ClientField1=&ClientField2=&ClientField3=&PayType=2&EdyReceiptNo=GDgm1J5k06090410&EdyOrderNo=ORDER0000001-220609334516&PaymentTerm=20220630235959ErrCode=E01&ErrInfo=E01040001